Itential Automation Platform

On this page:

Itential SNMP MIB

Objects Used for Traps

The Itential objects pertaining to the core Pronghorn application are listed in the table below.

Object Syntax Description
itenProngComponentID DisplayString The displayed ID of the adapter or application name.
itenProngAdapterIP4 * IpAddress IPv4 address of the adapter.
itenProngAdapterIP6 * Ipv6Address IPv6 address of the adapter.
itenProngAdapterPort * Unsigned32 Local listening port of the adapter.
itenProngAdapterFunction DisplayString Named function of the adapter.
itenProngAdapterError DisplayString System error message generated by the adapter.
itenProngSystemError DisplayString System error message generated by Pronghorn.

Note: The {*} objects are under consruction and may not be available within traps.

Notification Types

The Itential SNMP MIB defines seven notification types to inform OSS systems about system health events. Notifications are sent for both system events (restart and error) and southbound adapter events(established, unreachable and error).

Notification Object ID Description
itenSBAdapterUnreach 1.3.6.1.4.1.47688.1.1.1.0.1 An adapter related trap indicating that a connection could not be established to the specified southbound adapter.
itenSBAdapterEstab 1.3.6.1.4.1.47688.1.1.1.0.2 An adapter related trap indicating that a connection to the specified southbound adapter has been established.
itenSBAdapterFuncErr 1.3.6.1.4.1.47688.1.1.1.0.3 An adapter related trap indicating that an error has occurred with the specified southbound adapter.
itenProngSystemRestart 1.3.6.1.4.1.47688.1.1.1.0.4 A trap indicating that the Itential Automation Platform (IAP) has restarted.
itenProngSysErr 1.3.6.1.4.1.47688.1.1.1.0.5 A trap containing the contents of a critical error encountered by IAP.
itenProngAppUp 1.3.6.1.4.1.47688.1.1.1.0.6 A trap indicating an application is up and running.
itenProngAppDown 1.3.6.1.4.1.47688.1.1.1.0.7 A trap indicating an application is down and not running.

Southbound Adapter Notifications

Notifications may contain additional variable bindings providing detailed information about the event. These variable bindings can be used to identify specific components and error messages.

Notification Objects Description
itenSBAdapterUnreach itenProngComponentID
itenProngAdapterIP4
itenProngAdapterIP6
itenProngAdapterPort
Southbound adapter connection failure. The southbound adapter unreachable notifications contain the ID, IP and port of the unreachable instance.
itenSBAdapterEstab itenProngComponentID
itenProngAdapterIP4
itenProngAdapterIP6
itenProngAdapterPort
Southbound adapter connection established. The southbound adapter established notifications contain the ID, IP and port of the unreachable instance.
itenSBAdapterFuncErr itenProngComponentID
itenProngAdapterFunction
Southbound adapter function error. The southbound adapter error notifications contain the ID and function name.
itenProngSystemRestart The system restart notifications do not contain any detailed objects.
itenProngSysErr itenProngSystemError The system error notifications contain a string description of the error.
itenProngAppUp itenPronComponentID A trap indicating an application is up and running.
itenProngAppDown itenPronComponentID A trap indicating an application is down and not running.

Notification Objects for Compliance

Notification Group Object Description
itenProngNotifCompliance itenProngNotifObjectsGroup The compliance statement for systems supporting the Pronghorn Notification MIB.
itenProngNotifGroups itenProngNotifFaultsGroup The mandatory groups for compliance notification.

Notification Groups for Compliance

Notification Group Object Description
itenProngNotifObjectsGroup itenProngComponentID
itenProngAdapterIP4
itenProngAdapterIP6
itenProngAdapterPort
itenProngAdapterFunction
itenProngAdapterError
itenProngSystemError
Pronghorn (Itential) notification objects group.
itenProngNotifFaultsGroup itenSBAdapterUnreach
itenSBAdapterEstab
itenSBAdapterFuncErr
itenProngSystemRestart
itenProngSysErr
itenProngAppUp
itenProngAppDown
Pronghorn notification faults group.

SNMP MIB File

-- *******************************************************************
-- Itential Pronghorn objects MIB.
--
-- Copyright (c) 2016, Itential LLC.
-- All rights reserved.
--
-- The contents of this document are subject to change without notice.
-- *******************************************************************

ITENTIAL-PRONG-NOTIF-MIB DEFINITIONS ::= BEGIN

    IMPORTS
        IpAddress, Unsigned32,
        NOTIFICATION-TYPE, MODULE-IDENTITY,
        OBJECT-TYPE
            FROM SNMPv2-SMI
    MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
        FROM SNMPv2-CONF
        Ipv6Address
            FROM IPV6-TC
        DisplayString
            FROM SNMPv2-TC
    itenProngRoot
            FROM ITENTIAL-SMI-MIB;

    itenProngMib    MODULE-IDENTITY
        LAST-UPDATED "201901230000Z"
        ORGANIZATION  "Itential"
        CONTACT-INFO
            "Itential
             1350 Spring Street NW Suite 200
             Atlanta, Ga  30309

             E-mail: info@itential.com
         http://www.itential.com"

        DESCRIPTION
            "This module defines the objects pertaining to the core Pronghorn Application"

        REVISION      "201901230000Z"
        DESCRIPTION
            "Added itenProngAppUp and itenProngAppDown notification types. Renamed itenProngAdapterID object to itenProngComponentID."
        REVISION      "201604260000Z"
        DESCRIPTION
             "Initial release."

        ::= { itenProngRoot 1 }


    itenProngNotifications OBJECT IDENTIFIER ::= { itenProngMib 0 }
    itenProngNotifObjects  OBJECT IDENTIFIER ::= { itenProngMib 1 }
    itenProngNotifConformance   OBJECT IDENTIFIER ::= { itenProngMib 2 }


    -- ********************************************************************
    -- Objects used for the traps
    -- ********************************************************************
    itenProngComponentID   OBJECT-TYPE
        SYNTAX      DisplayString
        MAX-ACCESS  accessible-for-notify
        STATUS      current
        DESCRIPTION
            "The displayed ID of the adapter or application name."
        ::= { itenProngNotifObjects 1 }

    itenProngAdapterIP4   OBJECT-TYPE
        SYNTAX      IpAddress
        MAX-ACCESS  accessible-for-notify
        STATUS      current
        DESCRIPTION
            "IPv4 address of the adapter."
        ::= { itenProngNotifObjects 2 }

    itenProngAdapterIP6   OBJECT-TYPE
        SYNTAX      Ipv6Address
        MAX-ACCESS  accessible-for-notify
        STATUS      current
        DESCRIPTION
            "IPv6 address of the adapter."
        ::= { itenProngNotifObjects 3 }

    itenProngAdapterPort   OBJECT-TYPE
        SYNTAX      Unsigned32
        MAX-ACCESS  accessible-for-notify
        STATUS      current
        DESCRIPTION
            "Local listening port of the adapter."
        ::= { itenProngNotifObjects 4 }

    itenProngAdapterFunction   OBJECT-TYPE
        SYNTAX      DisplayString
        MAX-ACCESS  accessible-for-notify
        STATUS      current
        DESCRIPTION
            "Named function of the adapter."
        ::= { itenProngNotifObjects 5 }

    itenProngAdapterError   OBJECT-TYPE
        SYNTAX      DisplayString
        MAX-ACCESS  accessible-for-notify
        STATUS      current
        DESCRIPTION
            "System error message generated by the adapter."
        ::= { itenProngNotifObjects 6 }

    itenProngSystemError   OBJECT-TYPE
        SYNTAX      DisplayString
        MAX-ACCESS  accessible-for-notify
        STATUS      current
        DESCRIPTION
            "System error message generated by Pronghorn."
        ::= { itenProngNotifObjects 7 }

    -- ***************************************************************
    -- definition of Pronghorn related traps.
    -- ***************************************************************

    --
    -- Southbound adapter connection failure
    --
    itenSBAdapterUnreach  NOTIFICATION-TYPE
    OBJECTS        { itenProngComponentID,
            itenProngAdapterIP4,
            itenProngAdapterPort,
            itenProngAdapterIP6 }
        STATUS          current
        DESCRIPTION
            "An adapter related trap indicating that a
             connection could not be established to the
         specified southbound adapter. "
        ::= { itenProngNotifications 1 }

    --
    -- Southbound adapter connection established
    --
    itenSBAdapterEstab  NOTIFICATION-TYPE
    OBJECTS         { itenProngComponentID,
            itenProngAdapterIP4,
            itenProngAdapterPort,
            itenProngAdapterIP6 }
        STATUS          current
        DESCRIPTION
            "An adapter related trap indicating that a
             connection to the specified southbound adapter
         has been established. "
        ::= { itenProngNotifications 2 }

    --
    -- Southbound adapter function error
    --
    itenSBAdapterFuncErr  NOTIFICATION-TYPE
    OBJECTS          { itenProngComponentID,
            itenProngAdapterFunction }
        STATUS          current
        DESCRIPTION
            "An adapter related trap indicating that an
             error has occurred with the specified southbound adapter "
        ::= { itenProngNotifications 3 }

    --
    -- Pronghorn system restart
    --
    itenProngSystemRestart NOTIFICATION-TYPE
        STATUS          current
        DESCRIPTION
            "A trap indicating that the pronghorn has restarted."
        ::= { itenProngNotifications 4 }

    --
    -- Pronghorn system error
    --
    itenProngSysErr NOTIFICATION-TYPE
        OBJECTS         { itenProngSystemError }
        STATUS          current
        DESCRIPTION
            "A trap containing the contents of a critical error
         encountered by Pronghorn."
        ::= { itenProngNotifications 5 }

    --
    -- Application Up
    --
        itenProngAppUp NOTIFICATION-TYPE
        OBJECTS         { itenProngComponentID }
        STATUS          current
        DESCRIPTION
            "A trap indicating an application is up/running."
        ::= { itenProngNotifications 6 }

    --
    -- Application Down
    --
        itenProngAppDown NOTIFICATION-TYPE
        OBJECTS         { itenProngComponentID }
        STATUS          current
        DESCRIPTION
            "A trap indicating an application is down/not running."
        ::= { itenProngNotifications 7 }


    -- ******************************
    -- Conformance
    -- ******************************

    itenProngNotifCompliances    OBJECT IDENTIFIER ::= { itenProngNotifConformance 1 }
    itenProngNotifGroups    OBJECT IDENTIFIER ::= { itenProngNotifConformance 2 }

    itenProngNotifCompliance        MODULE-COMPLIANCE
    STATUS  current
    DESCRIPTION
    "The compliance statement for systems supporting
     the Pronghorn Notification MIB."
    MODULE -- this module
    -- MANDATORY-GROUPS {
    -- any mandatory groups should be mentioned here
    -- }
    GROUP       itenProngNotifObjectsGroup
    DESCRIPTION
        "This group is optional."
    GROUP       itenProngNotifFaultsGroup
    DESCRIPTION
        "This group is optional."
    ::= { itenProngNotifCompliances 1 }

    itenProngNotifObjectsGroup OBJECT-GROUP
    OBJECTS {
        itenProngComponentID,
        itenProngAdapterIP4,
        itenProngAdapterIP6,
        itenProngAdapterPort,
        itenProngAdapterFunction,
        itenProngAdapterError,
        itenProngAdapterError,
        itenProngSystemError
        }
    STATUS current
    DESCRIPTION
        "Pronghorn notification objects group."
    ::= { itenProngNotifGroups 1 }

    itenProngNotifFaultsGroup NOTIFICATION-GROUP
    NOTIFICATIONS {
        itenSBAdapterUnreach,
        itenSBAdapterEstab,
        itenSBAdapterFuncErr,
        itenProngSystemRestart,
        itenProngSysErr,
        itenProngAppUp,
        itenProngAppDown
            }

    STATUS current
    DESCRIPTION
        "Pronghorn notification faults group."
    ::= { itenProngNotifGroups 2 }

END